package com.zh.zhbootcommon.config.log;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

/**
 * 描述: Swagger2 配置类
 *
 * @author: yanglin
 * @Date: 2021-08-30-8:22
 * @Version: 1.0
 */
@EnableSwagger2
@Configuration
public class Swagger2Config {

    /**
     * @Api：修饰整个类，描述Controller的作用
     * @ApiOperation：描述一个类的一个方法，或者说一个接口
     * @ApiParam：单个参数描述
     * @ApiModel：用对象来接收参数
     * @ApiProperty：用对象接收参数时，描述对象的一个字段
     * @ApiResponse：HTTP响应其中1个描述
     * @ApiResponses：HTTP响应整体描述
     * @ApiIgnore：使用该注解忽略这个API
     * @ApiError ：发生错误返回的信息
     * @ApiImplicitParam：描述一个请求参数，可以配置参数的中文含义，还可以给参数设置默认值
     * @ApiImplicitParams：描述由多个 @ApiImplicitParam 注解的参数组成的请求参数列表
     */

    /**
     * 配置swagger的实例
     *
     * @param environment
     * @return
     */
    @Bean
    public Docket docket(Environment environment) {
        return new Docket(DocumentationType.SWAGGER_2)
                //这个可以自定义页面出现的标题，描述等信息
                .apiInfo(this.apiInfo())
                //是否开启swagger2，可以用作环境判断使用
                .enable(true)
                //筛选
                .select()
                //扫描的包
                .apis(RequestHandlerSelectors.basePackage("com.mm.controller"))
                //构建项目
                .build();
    }


    public ApiInfo apiInfo() {
        Contact contact = new Contact("JueDream", "https://gitee.com/yling_dream", "https://gitee.com/yling_dream");
        return new ApiInfo("木木打车",
                "木木打车",
                "v1.0",
                "urn:tos",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());
    }

}
